Skip to content

fix(server): prevent reference issues in ResponseHeadersPlugin#693

Merged
dinwwwh merged 1 commit into
mainfrom
fix/server/respnse-headers-plugin-reference-issue
Jun 26, 2025
Merged

fix(server): prevent reference issues in ResponseHeadersPlugin#693
dinwwwh merged 1 commit into
mainfrom
fix/server/respnse-headers-plugin-reference-issue

Conversation

@dinwwwh
Copy link
Copy Markdown
Member

@dinwwwh dinwwwh commented Jun 26, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of response headers to prevent unintended modifications and ensure data integrity.

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jun 26, 2025
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 26, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2025 7:39am

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @unnoq, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a potential issue within the ResponseHeadersPlugin where direct manipulation of response headers could lead to unintended side effects due to shared object references. The changes ensure that header modifications are performed on a distinct, cloned copy of the headers, promoting immutability and preventing unexpected behavior in subsequent processing steps by returning a new result object.

Highlights

  • Reference Safety: Implemented cloning of response headers within the ResponseHeadersPlugin to prevent unintended mutations of the original result.response.headers object, addressing potential side effects.
  • Immutability: Ensured that the ResponseHeadersPlugin operates on a new, cloned set of headers and returns a new result object, enhancing the immutability of the response data.
  • Dependency: Introduced an import for the clone utility from @orpc/shared to facilitate the deep copying of header objects.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 26, 2025

Walkthrough

This change updates the handling of response headers by deep cloning the headers object before modification, ensuring the original headers remain unchanged. The merged headers are then returned within a new response object, preserving immutability and explicitly updating the response structure.

Changes

File(s) Change Summary
packages/server/src/plugins/response-headers.ts Implements deep cloning of response headers before merging, and returns a new result object.

Possibly related PRs

  • unnoq/orpc#293: Addresses immutability and reference handling for response headers in the same plugin, focusing on correct cloning and management of header objects.

Poem

A hop, a skip, a header anew,
Cloned with care, no side effects in view.
Immutability now stands tall—
No more worries, none at all!
With every merge, the code feels lighter,
A rabbit’s touch makes logic brighter. 🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 197a894 and 01cc7cd.

📒 Files selected for processing (1)
  • packages/server/src/plugins/response-headers.ts (3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/server/src/plugins/response-headers.ts (1)
packages/shared/src/object.ts (1)
  • clone (48-64)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: publish-commit
  • GitHub Check: lint
🔇 Additional comments (3)
packages/server/src/plugins/response-headers.ts (3)

2-2: Good addition for immutability support.

The import of the clone function from the shared package is appropriate for implementing deep cloning of headers, which aligns with the PR objective of preventing reference issues.


33-33: Excellent fix for preventing reference mutations.

Deep cloning the headers before modification properly addresses the reference issue mentioned in the PR title. This ensures the original result.response.headers remains unchanged during the merging process.


47-53: Perfect immutable return pattern.

The restructured return statement completes the immutability fix by creating a new result object rather than mutating the original. This ensures the input result object remains completely unchanged, which aligns perfectly with the PR objective.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request fixes a reference issue in the ResponseHeadersPlugin by cloning the response headers before modification, preventing mutation of the original headers object. A potential issue was identified where the code could throw a TypeError if the response does not initially contain a headers object, and a suggestion has been provided to address this.

Comment thread packages/server/src/plugins/response-headers.ts
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Jun 26, 2025

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@693

@orpc/client

npm i https://pkg.pr.new/@orpc/client@693

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@693

@orpc/experimental-durable-event-iterator

npm i https://pkg.pr.new/@orpc/experimental-durable-event-iterator@693

@orpc/hey-api

npm i https://pkg.pr.new/@orpc/hey-api@693

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@693

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@693

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@693

@orpc/react

npm i https://pkg.pr.new/@orpc/react@693

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@693

@orpc/server

npm i https://pkg.pr.new/@orpc/server@693

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@693

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@693

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@693

@orpc/standard-server-aws-lambda

npm i https://pkg.pr.new/@orpc/standard-server-aws-lambda@693

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@693

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@693

@orpc/standard-server-peer

npm i https://pkg.pr.new/@orpc/standard-server-peer@693

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@693

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@693

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@693

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@693

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@693

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@693

commit: 01cc7cd

@dinwwwh dinwwwh merged commit a153125 into main Jun 26, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant